/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ai.h2o.sparkling.ml.params

import org.apache.spark.expose.Logging
import org.apache.spark.ml.param.{Param, Params}

/**
  * The trait represents a definition of ML algorithm parameters that may contain some deprecations
  */
trait DeprecatableParams extends Params with Logging {

  /**
    * When a parameter is renamed, the mapping 'old name' -> 'new name' should be added into this map.
    */
  protected def renamingMap: Map[String, String]

  private def applyRenaming(parameterName: String): String = renamingMap.getOrElse(parameterName, parameterName)

  override def hasParam(paramName: String): Boolean = super.hasParam(applyRenaming(paramName))

  override def getParam(paramName: String): Param[Any] = super.getParam(applyRenaming(paramName))
}
